DOC: Improve docstring of Index.delete #32015
Merged
+22
−1
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
pandas/core/indexes/base.py
Outdated
| @@ -5135,9 +5135,30 @@ def delete(self, loc): | |||
| """ | |||
| Make new Index with passed location(-s) deleted. | |||
|
|
|||
| Use array of integer as loc parameter to delete multiple locations. | |||
There was a problem hiding this comment.
Can you explain this in the parameter description please
pandas/core/indexes/base.py
Outdated
|
|
||
| Parameters | ||
| ---------- | ||
| loc : int |
pandas/core/indexes/base.py
Outdated
| Examples | ||
| -------- | ||
| >>> idx = pd.Index(['a', 'b', 'c']) | ||
| >>> idx.delete(1) # Deleting 'b' |
There was a problem hiding this comment.
I think you can remove the comment, the example is good enough to be clear that we're deleting b
|
Hello @andhikayusup! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found: There are currently no PEP 8 issues detected in this Pull Request. Cheers! 🍻 Comment last updated at 2020-02-15 12:19:52 UTC |
datapythonista
approved these changes
Feb 15, 2020
pandas/core/indexes/base.py
Outdated
| ---------- | ||
| loc : int or list of int | ||
| Location of item(-s) which will be deleted. | ||
| Use list of integer as loc parameter to delete multiple locations. |
There was a problem hiding this comment.
What do you think about the next?
Use a list of locations to delete more than one value at the same time
|
Thanks @andhikayusup |
roberthdevries
pushed a commit
to roberthdevries/pandas
that referenced
this pull request
Mar 2, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
black pandasgit diff upstream/master -u -- "*.py" | flake8 --diffOutput from validate_docstrings.py
################################################################################
####################### Docstring (pandas.Index.delete) #######################
################################################################################
Make new Index with passed location(-s) deleted.
Use array of integer as loc parameter to delete multiple locations.
Parameters
loc : int
Location of item(-s) which will be deleted.
Returns
Index
New Index with passed location(-s) deleted.
See Also
numpy.delete : Delete any rows and column from NumPy array (ndarray).
Examples
################################################################################
################################## Validation ##################################
################################################################################